package cn.tedu.tea.front.server.content.service;

import cn.tedu.tea.front.server.common.pojo.vo.PageData;
import cn.tedu.tea.front.server.common.security.CurrentPrincipal;
import cn.tedu.tea.front.server.content.pojo.vo.ArticleListItemVO;
import cn.tedu.tea.front.server.content.pojo.vo.ArticleStandardVO;
import org.springframework.transaction.annotation.Transactional;

import java.util.List;

/**
 * 处理文章数据的业务接口
 *
 * @author java@tedu.cn
 * @version 1.0
 */
@Transactional
public interface IArticleService {

    /**
     * 踩或顶的显示文本
     */
    String[] UP_DOWN_TEXT = {"踩", "顶"};

    /**
     * 增加"顶"数量
     *
     * @param currentPrincipal 当事人
     * @param id               文章ID
     */
    void increaseUpCount(CurrentPrincipal currentPrincipal, Long id);

    /**
     * 增加"踩"数量
     *
     * @param currentPrincipal 当事人
     * @param id               文章ID
     */
    void increaseDownCount(CurrentPrincipal currentPrincipal, Long id);

    /**
     * 根据ID查询文章详情
     *
     * @param id 文章ID
     * @return 匹配的文章数据详情，如果没有匹配的数据，则返回null
     */
    ArticleStandardVO getStandardById(Long id);

    /**
     * 查询文章列表
     *
     * @return 文章列表
     */
    List<ArticleListItemVO> list();

    /**
     * 查询文章列表，将使用默认的每页记录数
     *
     * @param pageNum 页码
     * @return 文章列表
     */
    PageData<ArticleListItemVO> list(Integer pageNum);

    /**
     * 查询文章列表
     *
     * @param pageNum  页码
     * @param pageSize 每页记录数
     * @return 文章列表
     */
    PageData<ArticleListItemVO> list(Integer pageNum, Integer pageSize);

    /**
     * 根据文章类别查询文章列表，将使用默认的每页记录数
     *
     * @param categoryId 文章类别的ID
     * @param pageNum    页码
     * @return 文章列表
     */
    PageData<ArticleListItemVO> listByCategoryId(Long categoryId, Integer pageNum);

    /**
     * 根据文章类别查询文章列表
     *
     * @param categoryId 文章类别的ID
     * @param pageNum    页码
     * @param pageSize   每页记录数
     * @return 文章列表
     */
    PageData<ArticleListItemVO> listByCategoryId(Long categoryId, Integer pageNum, Integer pageSize);

    /**
     * 重建缓存中的文章列表
     */
    void rebuildListCache();

}
